Create/Update Contact
Create or update a contact in the phone's address book.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Keep the contact name aligned with your CRM's customer name.
Use formatted names (e.g., 'Alice - Support') for clarity.
Managing Your Digital Rolodex
The /v2/contacts/update endpoint allows you to modify the local name of a contact in your WhatsApp address book.
📖 The Name Game: Private vs Public
It is vital to distinguish between the two types of names in WhatsApp.
1. pushname (Public)
- What: The name Alice chose for herself ("Alice 🌸").
- Editable: NO. You cannot change this. Only Alice can.
2. name (Private)
- What: The name you saved Alice as in your phone ("Alice from Accounting").
- Editable: YES. This endpoint changes this value.
- Visibility: Only you (the bot owner) see this. Alice does not know you saved her as "Alice from Accounting".
🛠️ Use Cases
1. CRM Synchronization
If you have a CRM like Salesforce, you want your WhatsApp chat list to reflect your CRM data.
- Scenario: A new lead messages you. Their pushname is "User123".
- Action: Your agent asks for their name. They say "Bob Smith".
- API Call: Update contact
123@c.uswithfirstName: "Bob", lastName: "Smith". - Result: In your chat list, they now appear as "Bob Smith".
2. Funnel Tracking
You can append tags to names to visualize where a user is in your funnel.
- Example: "Bob [Lead]" -> "Bob [Customer]" -> "Bob [VIP]".
- Benefit: Agents can instantly see the user's status just by looking at the chat header.
🏗️ Technical Nuances
The Virtual Address Book
Since Wawp is a cloud-based system, we emulate the behavior of a mobile OS address book.
- Persistence: Updates are stored in the session's internal database.
- Sync: If you are using a multi-device session, this change might sync to your physical phone (if connected), but it is primarily for the API session's context.
"Creating" a Contact
This endpoint is idempotent.
- If the contact exists: It updates the name.
- If the contact is new: It "adds" them to your address book. This resolves the
name: nullissue when fetching contact details later.
❓ FAQ
Q: Will the user see the name I gave them? A: No. This is private data on your end.
Q: Can I update the profile picture too? A: No. You cannot change another user's photo.
Q: What if I only provide a firstName?
A: The API will set the full name to just the firstName.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Request Body
Sent as a JSON objectstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | The unique ID of the contact Example: | ||
string | — | First name of the contact Example: | |
string | — | Last name of the contact Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"ok": true
}Command Palette
Search for a command to run...